/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.ranger.view;

/**
 * User
 */

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import org.apache.ranger.common.AppConstants;
import org.apache.ranger.common.RangerCommonEnums;

import java.util.Collection;

@JsonAutoDetect(getterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE, fieldVisibility = Visibility.ANY)
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class VXUser extends VXDataObject implements java.io.Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * Name
     */
    protected String             name;
    /**
     * First Name
     */
    protected String             firstName;
    /**
     * Last Name
     */
    protected String             lastName;
    /**
     * Email address
     */
    protected String             emailAddress;
    /**
     * Password
     */
    protected String             password;
    /**
     * Description
     */
    protected String             description;
    /**
     * Id of the credential store
     */
    protected Long               credStoreId;
    /**
     * List of group ids
     */
    protected Collection<Long>   groupIdList;
    protected Collection<String> groupNameList;

    protected int                status;
    protected Integer            isVisible;
    protected int                userSource;
    /**
     * List of roles for this user
     */
    protected Collection<String> userRoleList;

    /**
     * Additional store attributes.
     *
     */
    protected String otherAttributes;

    /**
     * Sync Source
     */
    protected String syncSource;

    /**
     * Default constructor. This will set all the attributes to default value.
     */
    public VXUser() {
        isVisible = RangerCommonEnums.IS_VISIBLE;
    }

    /**
     * Returns the value for the member attribute <b>name</b>
     * @return String - value of member attribute <b>name</b>.
     */
    public String getName() {
        return this.name;
    }

    /**
     * This method sets the value to the member attribute <b>name</b>.
     * You cannot set null to the attribute.
     * @param name Value to set member attribute <b>name</b>
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Returns the value for the member attribute <b>firstName</b>
     * @return String - value of member attribute <b>firstName</b>.
     */
    public String getFirstName() {
        return this.firstName;
    }

    /**
     * This method sets the value to the member attribute <b>firstName</b>.
     * You cannot set null to the attribute.
     * @param firstName Value to set member attribute <b>firstName</b>
     */
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    /**
     * Returns the value for the member attribute <b>lastName</b>
     * @return String - value of member attribute <b>lastName</b>.
     */
    public String getLastName() {
        return this.lastName;
    }

    /**
     * This method sets the value to the member attribute <b>lastName</b>.
     * You cannot set null to the attribute.
     * @param lastName Value to set member attribute <b>lastName</b>
     */
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    /**
     * Returns the value for the member attribute <b>emailAddress</b>
     * @return String - value of member attribute <b>emailAddress</b>.
     */
    public String getEmailAddress() {
        return this.emailAddress;
    }

    /**
     * This method sets the value to the member attribute <b>emailAddress</b>.
     * You cannot set null to the attribute.
     * @param emailAddress Value to set member attribute <b>emailAddress</b>
     */
    public void setEmailAddress(String emailAddress) {
        this.emailAddress = emailAddress;
    }

    /**
     * Returns the value for the member attribute <b>password</b>
     * @return String - value of member attribute <b>password</b>.
     */
    public String getPassword() {
        return this.password;
    }

    /**
     * This method sets the value to the member attribute <b>password</b>.
     * You cannot set null to the attribute.
     * @param password Value to set member attribute <b>password</b>
     */
    public void setPassword(String password) {
        this.password = password;
    }

    /**
     * Returns the value for the member attribute <b>description</b>
     * @return String - value of member attribute <b>description</b>.
     */
    public String getDescription() {
        return this.description;
    }

    /**
     * This method sets the value to the member attribute <b>description</b>.
     * You cannot set null to the attribute.
     * @param description Value to set member attribute <b>description</b>
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Returns the value for the member attribute <b>credStoreId</b>
     * @return Long - value of member attribute <b>credStoreId</b>.
     */
    public Long getCredStoreId() {
        return this.credStoreId;
    }

    /**
     * This method sets the value to the member attribute <b>credStoreId</b>.
     * You cannot set null to the attribute.
     * @param credStoreId Value to set member attribute <b>credStoreId</b>
     */
    public void setCredStoreId(Long credStoreId) {
        this.credStoreId = credStoreId;
    }

    /**
     * Returns the value for the member attribute <b>groupIdList</b>
     * @return Collection<Long> - value of member attribute <b>groupIdList</b>.
     */
    public Collection<Long> getGroupIdList() {
        return this.groupIdList;
    }

    /**
     * This method sets the value to the member attribute <b>groupIdList</b>.
     * You cannot set null to the attribute.
     * @param groupIdList Value to set member attribute <b>groupIdList</b>
     */
    public void setGroupIdList(Collection<Long> groupIdList) {
        this.groupIdList = groupIdList;
    }

    @Override
    public int getMyClassType() {
        return AppConstants.CLASS_TYPE_XA_USER;
    }

    /**
     * This return the bean content in string format
     * @return formatedStr
     */
    public String toString() {
        String str = "VXUser={";
        str += super.toString();
        str += "name={" + name + "} ";
        str += "firstName={" + firstName + "} ";
        str += "lastName={" + lastName + "} ";
        str += "emailAddress={" + emailAddress + "} ";
        str += "description={" + description + "} ";
        str += "credStoreId={" + credStoreId + "} ";
        str += "isVisible={" + isVisible + "} ";
        str += "groupIdList={" + groupIdList + "} ";
        str += "groupNameList={" + groupNameList + "} ";
        str += "roleList={" + userRoleList + "} ";
        str += "otherAttributes={" + otherAttributes + "} ";
        str += "syncSource={" + syncSource + "} ";
        str += "}";
        return str;
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

    public Integer getIsVisible() {
        return isVisible;
    }

    public void setIsVisible(Integer isVisible) {
        this.isVisible = isVisible;
    }

    public int getUserSource() {
        return userSource;
    }

    public void setUserSource(int userSource) {
        this.userSource = userSource;
    }

    /**
     * Returns the value for the member attribute <b>userRoleList</b>
     * @return Collection<String> - value of member attribute <b>userRoleList</b>.
     */
    public Collection<String> getUserRoleList() {
        return this.userRoleList;
    }

    /**
     * This method sets the value to the member attribute <b>userRoleList</b>.
     * You cannot set null to the attribute.
     * @param userRoleList Value to set member attribute <b>userRoleList</b>
     */
    public void setUserRoleList(Collection<String> userRoleList) {
        this.userRoleList = userRoleList;
    }

    public Collection<String> getGroupNameList() {
        return groupNameList;
    }

    public void setGroupNameList(Collection<String> groupNameList) {
        this.groupNameList = groupNameList;
    }

    /**
     * @return {@link String} - additional attributes.
     */
    public String getOtherAttributes() {
        return otherAttributes;
    }

    /**
     * This method sets additional attributes.
     * @param otherAttributes
     */
    public void setOtherAttributes(final String otherAttributes) {
        this.otherAttributes = otherAttributes;
    }

    /**
     * @return {@link String} - sync Source.
     */
    public String getSyncSource() {
        return syncSource;
    }

    /**
     * This method sets additional attributes.
     * @param syncSource
     */
    public void setSyncSource(String syncSource) {
        this.syncSource = syncSource;
    }
}
